Source for file containers.class.php

Documentation is available at containers.class.php

  1. <?php
  2.  
  3. class mosContainer extends mosTableEntry {
  4.     /** @var int ID for container record in database */
  5.     public $id = 0;
  6.     /** @var int Ordering */
  7.     public $ordering = 0;
  8.     /** @var string Window title */
  9.     public $windowtitle = '';
  10.     /** @var string Key words */
  11.     public $keywords = '';
  12.     /** @var int ID of parent container in database if a folder */
  13.     public $parentid = 0;
  14.     /** @var string Name of container */
  15.     public $name = '';
  16.     /** @var string Container description */
  17.     public $description='';
  18.     /** @var bool Is the container published? */
  19.     public $published=false;
  20.     /** @var string Icon - not sure how this is used */
  21.     public $icon='';
  22.     /** @var bool Has all the data been loaded (rather than just the basics) */
  23.     protected $loaded = 0;
  24.     /** @var array Child containers */
  25.     protected $children = array();
  26.     /** @var bool When true, the item is marked as trash */
  27.     protected $isTrash = false;
  28.  
  29.     function tableName () {
  30.         return '#__containers';
  31.     }
  32.  
  33.     function notSQL () {
  34.         return array ('id', 'loaded', 'children', 'database');
  35.     }
  36.  
  37.     function load () {
  38.         $database = mamboDatabase::getInstance();
  39.         if ($this->loaded == 0 AND $this->id) {
  40.             $database->setQuery("SELECT * FROM #__containers WHERE id=$this->id");
  41.             $database->loadObject($this);
  42.             $this->loaded = 1;
  43.         }
  44.     }
  45.  
  46.     function saveValues () {
  47.         $database = mamboDatabase::getInstance();
  48.         $this->prepareValues();
  49.         if ($this->id == 0) $database->doSQL($this->insertSQL());
  50.         else $database->doSQL($this->updateSQL());
  51.     }
  52.  
  53.     function trash () {
  54.         $this->isTrash = true;
  55.     }
  56.  
  57.     function isTrash () {
  58.         return $this->isTrash;
  59.     }
  60.  
  61.     function addChild ($id) {
  62.         $this->children[] = $id;
  63.     }
  64.  
  65.     function deleteAll () {
  66.         $folders = $this->getChildren(false);
  67.         foreach ($folders as $folder) $folder->deleteAll ();
  68. //      Need to delete things that are registered with this
  69.         $this->trash();
  70.     }
  71.  
  72.     function setMetaData () {
  73.         $mainframe = mosMainFrame::getInstance();
  74.         $mainframe->prependMetaTag('description', strip_tags($this->name));
  75.         if ($this->keywords) $mainframe->prependMetaTag('keywords', $this->keywords);
  76.         else $mainframe->prependMetaTag('keywords', $this->name);
  77.     }
  78.  
  79.     function isCategory () {
  80.         if ($this->parentid == 0) return true;
  81.         else return false;
  82.     }
  83.  
  84.     function getCategoryName ($showself=false) {
  85.         $category = $this->getCategory();
  86.         if ($this->parentid OR $showself) return $category->name;
  87.         return '*';
  88.     }
  89.  
  90.     function getCategory () {
  91.         $container =& $this;
  92.         while ($container->parentid) $container =& $container->getParent();
  93.         return $container;
  94.     }
  95.  
  96.     function getFamilyNames ($include=false) {
  97.         $names = $include ? '/'.$this->name : '';
  98.         $generation = 1;
  99.         $ancestor =& $this;
  100.         while ($ancestor->parentid AND $generation < 3) {
  101.             $ancestor =& $ancestor->getParent();
  102.             $generation++;
  103.             $names = '/'.$ancestor->name.$names;
  104.         }
  105.         if ($ancestor->parentid) $names = '..'.$names;
  106.         if ($names) return $names;
  107.         return '-';
  108.     }
  109.  
  110.     function &addChildren (&$descendants, $published=true, $search='', $recurse=false) {
  111.         $children = array();
  112.         $handler = mosContainerHandler::getInstance();
  113.         foreach ($this->children as $i) {
  114.             $container =& $handler->getBasicContainer($i);
  115.             if ($published AND $container->published == 0) continue;
  116.             if ($search AND strpos(strtolower($container->name), strtolower($search)) === false) continue;
  117.             $children[] =& $container;
  118.             $descendants[] =& $container;
  119.         }
  120.         if ($recurse) foreach ($children as $child) $child->addChildren ($descendants, $published, $search, $recurse);
  121.         return $children;
  122.     }
  123.  
  124.     function &getChildren ($published=true, $search='') {
  125.         $children = array();
  126.         $this->addChildren($children, $published, $search);
  127.         return $children;
  128.     }
  129.  
  130.     function &getDescendants ($search='') {
  131.         $descendants = array();
  132.         $this->addChildren ($descendants, false, $search, true);
  133.         return $descendants;
  134.     }
  135.  
  136.     function &getParent () {
  137.         $handler = mosContainerHandler::getInstance();
  138.         $parent =& $handler->getBasicContainer($this->parentid);
  139.         return $parent;
  140.     }
  141.  
  142.     function getSelectList ($type, $parm, $published, $notThis=0) {
  143.         $selector[] = mosHTML::makeOption(0,T_('No parent'));
  144.         $handler = mosContainerHandler::getInstance();
  145.         foreach ($handler->getCategories() as $category) $category->addSelectList('',$selector,$notThis,$published);
  146.         return mosHTML::selectList( $selector, $type, $parm, 'value', 'text', $this->id );
  147.     }
  148.  
  149.     function addSelectList ($prefix, &$selector, $notThis, $published) {
  150.         if (($notThis == 0) OR ($this->id != $notThis)) $selector[] = mosHTML::makeOption($this->id, $prefix.htmlspecialchars($this->name));
  151.         foreach ($this->getChildren($published) as $container) $container->addSelectList($prefix.$this->name.'/',$selector,$notThis,$published);
  152.     }
  153.  
  154.     function getURL () {
  155.     }
  156.  
  157.     function setPathway () {
  158.     }
  159.  
  160.     function &getIcons () {
  161.         $iconList = '';
  162.         $live_site = mamboCore::get('mosConfig_live_site');
  163.         $iconDir = new mosDirectory (mamboCore::get('mosConfig_absolute_path').'/administrator/components/com_containers/images/folder_icons');
  164.         $files = $iconDir->listAll();
  165.         $ss = 0;
  166.         foreach ($files as $file) {
  167.             $iconList.="\n<a href=\"JavaScript:paste_strinL('{$file}')\" onmouseover=\"window.status='{$file}'; return true\"><img src=\"{$live_site}/administrator/components/com_containers/images/folder_icons/{$file}\" width=\"32\" height=\"32\" border=\"0\" alt=\"{$file}\" /></a>&nbsp;&nbsp;";
  168.             $ss++;
  169.             if ($ss % 10 == 0) $iconList.="<br/>\n";
  170.         }
  171.         return $iconList;
  172.     }
  173.  
  174.  
  175.     function togglePublished ($idlist, $value) {
  176.         $cids = implode( ',', $idlist );
  177.         $sql = "UPDATE #__downloads_containers SET published=$value". "\nWHERE id IN ($cids)";
  178.         remositoryRepository::doSQL ($sql);
  179.     }
  180.  
  181.     function mosImageURL($imageName, $width=32, $height=32) {
  182.         $live_site = mamboCore::get('mosConfig_live_site');
  183.         $element = '<img src="';
  184.         $element .= $live_site.'/administrator/components/com_containers/images/'.$imageName;
  185.         $element .= '" width="';
  186.         $element .= $width;
  187.         $element .= '" height="';
  188.         $element .= $height;
  189.         $element .= '" border="0" align="middle" alt="';
  190.         $element .= $imageName;
  191.         $element .= '"/>';
  192.         return $element;
  193.     }
  194.  
  195. }
  196.  
  197. class mosContainerHandler {
  198.     var $rows = array();
  199.     var $links = array();
  200.     var $anchor = '';
  201.  
  202.     function mosContainerHandler () {
  203.         $this->resetData();
  204.     }
  205.  
  206.     static function &getInstance () {
  207.         static $instance;
  208.         if (!is_object($instance)) $instance = new mosContainerHandler();
  209.         return $instance;
  210.     }
  211.     
  212.     function resetData () {
  213.         unset ($this->rows, $this->links, $this->anchor);
  214.         $database = mamboDatabase::getInstance();
  215.         $this->anchor =& new mosContainer();
  216.         $sql = 'SELECT id, parentid, name, published, ordering FROM #__containers ORDER BY ordering, name';
  217.         $this->rows =& $database->doSQLget($sql, 'mosContainer');
  218.         foreach ($this->rows as $i=>$row) $this->links[$row->id] = $i;
  219.         foreach ($this->rows as $row) if ($row->parentid) {
  220.             $parent =& $this->rows[$this->links[$row->parentid]];
  221.             $parent->addChild($row->id);
  222.         }
  223.         else $this->anchor->addChild($row->id);
  224.     }
  225.  
  226.     function &getBasicContainer ($id) {
  227.         if ($id == 0) return $this->anchor;
  228.         return $this->rows[$this->links[$id]];
  229.     }
  230.  
  231.     function &getContainer ($id) {
  232.         global $database;
  233.         $result =& $this->getBasicContainer($id);
  234.         $result->load();
  235.         return $result;
  236.     }
  237.  
  238.     function &getCategories ($published = false, $search = null) {
  239.         $categories = array();
  240.         foreach ($this->anchor->getChildren() as $category) {
  241.             if ($published AND $category->published == 0) continue;
  242.             if ($search AND strpos(strtolower($category->name), strtolower($search)) === false) continue;
  243.             $categories[] = $category;
  244.         }
  245.         return $categories;
  246.     }
  247.  
  248.     function getDescendantIDList ($id, $search='') {
  249.         $top = $this->getBasicContainer ($id);
  250.         $descendants =& $top->getDescendants ($search);
  251.         $list = $id;
  252.         foreach ($descendants as $descendant) $list .= ','.$descendant->id;
  253.         return $list;
  254.     }
  255.  
  256.     function getSelectList ($allowTop, $default, $type, $parm, &$user) {
  257.         if ($allowTop) $selector[] = mosHTML::makeOption(0,_DOWN_NO_PARENT);
  258.         foreach ($this->getCategories() as $category) $category->addSelectList('', $selector, null, $user);
  259.         if (isset($selector)) return mosHTML::selectList( $selector, $type, $parm, 'value', 'text', $default );
  260.         else return '';
  261.     }
  262.  
  263.     // Only needed for testing
  264.     function displayChildren (&$container) {
  265.         echo '<br />'.$container->name.' has children:<br />';
  266.         foreach ($container->children as $child) echo $child->name.' whose parent is '.$child->parent->name.'<br />';
  267.         foreach ($container->children as $child) displayChildren ($child);
  268.     }
  269.  
  270.     function markTrash () {
  271.         $database = mamboDatabase::getInstance();
  272.         foreach ($this->rows as $row) if ($row->isTrash()) $trash[] = $row->id;
  273.         if (isset($trash)) {
  274.             $trashlist = implode (',', $trash);
  275.             $sql = "DELETE FROM #__containers WHERE id IN ($trashlist)";
  276.             $database->doSQL($sql);
  277.         }
  278.     }
  279.  
  280. }
  281.  
  282. ?>

Documentation generated on Mon, 05 May 2008 16:18:16 +0400 by phpDocumentor 1.4.0